XPDF
Type
library
Description
XPDF is an external for viewing, selecting and extracting text and images from PDF files.
Associated Syntax
Command
| Name | Summary | Syntax |
|---|---|---|
| XPDFViewer_Open | Create a named PDF Viewer associated with a specific stack window. | XPDFViewer_Open <viewerName>, <stackWindowId> |
| XPDFViewer_GoToPage | Navigate to a page using either one of the four navigation constants or a specific pageNumber. | XPDFViewer_GoToPage <viewerName>, {"last" | "first" | "next" | "prev" | <pageNumber>} |
| XPDFViewer_ChooseMouseMode | Choose a mouse mode. The viewer defaults to browse mode. Choose selection to select text. | XPDFViewer_ChooseMouseMode <viewerName>, {"selection" | "browse" | "image" } |
| XPDFViewer_Zoom | Zoom the page using either one of the five zoom constants or a specified percentage. | XPDFViewer_Zoom <viewerName>, {"width" | "fit" | "actual" | "in" | "out" | <percent>} |
| XPDFViewer_Close | Close an open PDF view. | XPDFViewer_Close <viewerName> |
| XPDFViewer_Set | Set a property of the PDF Viewer. | XPDFViewer_Set <viewerName>, <property>, <value> |
| XPDFViewer_Unicode | This command sets the value of a named variable to the UTF16 encoded text of a specific page. | XPDFViewer_Unicode <viewerName>, <pageNumber>, <variableName> |
| XPDFViewer_Image | This command sets the value of a named variable to the imageData of the rendered page. | XPDFViewer_Image <viewerName>, <pageNumber>, <variableName> |
| XPDFViewer_GetSelectionUnicode | This command sets the value of a named variable to the UTF16 encoded text of the current selection. | XPDFViewer_GetSelectionUnicode <viewerName>, <variableName> |
| XPDFViewer_Select | Set the current selection of the PDF Viewer to a specific range. | XPDFViewer_Select <viewerName>, <startPageNumber>, <startCharOnPage>, <endPageNumber>, <endCharOnPage> |
| XPDFViewer_GetSelectionImage | This command sets the value of a named variable to the imageData of the current image selection. | XPDFViewer_GetSelectionImage <viewerName>, <variableName> |
| XPDFViewer_SelectImage | Set the current image selection of the PDF Viewer to a specific range. | XPDFViewer_SelectImage <viewerName>, <pageNumber>, <left>, <top>, <right>, <bottom> |
Function
| Name | Summary | Syntax |
|---|---|---|
| XPDFViewer_Get | Get the value of a property from a PDF Viewer. | XPDFViewer_Get(<viewerName>, <property>) |
| XPDFViewer_Text | Return the text of a page in ANSI. | XPDFViewer_Text(<viewerName>, <pageNumber>) |
| XPDFViewer_CharacterCount | Count the number of characters on a page. | XPDFViewer_CharacterCount(<viewerName>, <pageNumber>) |
| XPDFViewer_GetSelectionRect | Get the rect of the portion of the selection that appears on the currently loaded page. | XPDFViewer_GetSelectionRect(<viewerName>[, <pageNumber>]) |
| XPDFViewer_GetSelectionText | Return the selected text in ANSI. | XPDFViewer_GetSelectionText(<viewerName>) |
| XPDFViewer_GetSelectionRange | Get the current selectionRange from a PDF Viewer. | XPDFViewer_GetSelectionRange(<viewerName>) |
| XPDFViewer_GetImageSelectionRect | Get the rect of image selection. | XPDFViewer_GetImageSelectionRect(<viewerName>) |
| XPDFViewer_GetImageSelectionRange | Get the current image selectionRange from a PDF Viewer. | XPDFViewer_GetImageSelectionRange(<viewerName>) |
Message
| Name | Summary | Syntax |
|---|---|---|
| XPDF_ScrollTopOfPage | Sent to the current card when scrolling to the top of page | XPDF_ScrollTopOfPage |
| XPDF_SelectTopOfPage | Sent to the current card when selecting to the top of page | XPDF_SelectTopOfPage |
| XPDF_ScrollBottomOfPage | Sent to the current card when scrolling to the bottom of page | XPDF_ScrollBottomOfPage |
| XPDF_SelectBottomOfPage | Sent to the current card when selecting to the bottom of page | XPDF_SelectBottomOfPage |
| XPDF_SelectionChanged | Sent to the current card when the user changes the text selection | XPDF_SelectionChanged <selectionRange> |
| XPDF_ImageSelectionChanged | Sent to the current card when the user changes the image selection | XPDF_ImageSelectionChanged <selectionRange> |
| XPDF_ScrollbarDragged | Sent to the current card when the user scrolls the view | XPDF_ScrollbarDragged <scroll> |
| XPDF_LinkClicked | Sent to the current card when the user scrolls the view | XPDF_LinkClicked <link> |